POST api/v1/dataservice/findasync/{tableName}?fieldList[0]={fieldList[0]}&fieldList[1]={fieldList[1]}
Initiates a Finds data request in specified table with given search parameters asynchronously. You must call findasyncgetresult to retrieve results
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| tableName |
Name of the table to search. |
string |
Required |
| fieldList |
The list of fields to return. (optional). If empty, all fields will be returned |
Collection of string |
Required |
Body Parameters
The search parameters.
Query| Name | Description | Type | Additional information |
|---|---|---|---|
| Operator | LogicalOperator |
Required |
|
| PagingData | PagingData |
Required |
|
| SearchFields | Collection of QueryField |
Required |
|
| ReturnDataFormat | Collection of DataFieldFormat |
None. |
Request Formats
application/json, text/json
Sample:
{
"Operator": "And",
"PagingData": {
"PageSize": 1,
"PageIndex": 2,
"TotalRecords": 3,
"TotalPages": 4,
"Token": "sample string 5"
},
"SearchFields": [
{
"FieldName": "sample string 1",
"Value": "sample string 2",
"ComparisonOperator": "Equal"
},
{
"FieldName": "sample string 1",
"Value": "sample string 2",
"ComparisonOperator": "Equal"
}
],
"ReturnDataFormat": [
{
"Name": "sample string 1",
"Format": "sample string 2",
"AnonymizationOption": "Default"
},
{
"Name": "sample string 1",
"Format": "sample string 2",
"AnonymizationOption": "Default"
}
]
}
application/xml, text/xml
Sample:
<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paperclip.IOTA.WebApi.Model">
<Operator>And</Operator>
<PagingData>
<PageIndex>2</PageIndex>
<PageSize>1</PageSize>
<Token>sample string 5</Token>
<TotalPages>4</TotalPages>
<TotalRecords>3</TotalRecords>
</PagingData>
<ReturnDataFormat>
<DataFieldFormat>
<AnonymizationOption>Default</AnonymizationOption>
<Format>sample string 2</Format>
<Name>sample string 1</Name>
</DataFieldFormat>
<DataFieldFormat>
<AnonymizationOption>Default</AnonymizationOption>
<Format>sample string 2</Format>
<Name>sample string 1</Name>
</DataFieldFormat>
</ReturnDataFormat>
<SearchFields>
<QueryField>
<ComparisonOperator>Equal</ComparisonOperator>
<FieldName>sample string 1</FieldName>
<Value>sample string 2</Value>
</QueryField>
<QueryField>
<ComparisonOperator>Equal</ComparisonOperator>
<FieldName>sample string 1</FieldName>
<Value>sample string 2</Value>
</QueryField>
</SearchFields>
</Query>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Returns Ticket Id to be used by caller to retrieve result
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>
text/plain
Sample:
sample string 1